fix: avoid omitting boolean values when serializing#389
Open
DavidLindbom wants to merge 1 commit into
Open
Conversation
ThomasVerhoeven1998
approved these changes
Mar 28, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR addresses a GitOps reconciliation loop caused by omitempty dropping false boolean values during JSON serialization, leading the operator to unintentionally remove explicitly-set boolean fields (e.g., tlsAllowInsecureConnection: false) from resources.
Changes:
- Removed
omitemptyfrom various boolean JSON tags across CRD Go types to ensurefalsevalues are serialized. - Added a Ginkgo test to assert
falseboolean values are preserved in JSON output forPulsarTopicStatus.GeoReplicationEnabled.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 24 comments.
Show a summary per file
| File | Description |
|---|---|
| controllers/pulsartopic_boolean_persistence_test.go | Adds a serialization regression test for a false status boolean. |
| api/v1alpha1/pulsartopic_types.go | Removes omitempty from several boolean fields (spec + status). |
| api/v1alpha1/pulsarsink_types.go | Removes omitempty from boolean spec fields. |
| api/v1alpha1/pulsarnamespace_types.go | Removes omitempty from multiple boolean fields (including nested configs/status). |
| api/v1alpha1/pulsarfunction_types.go | Removes omitempty from multiple boolean spec fields. |
| api/v1alpha1/pulsarconnection_types.go | Removes omitempty from connection TLS boolean flags to preserve false. |
| api/v1alpha1/computeworkspace_types.go | Removes omitempty from a boolean pointer field. |
| api/v1alpha1/computeflinkdeployment_types.go | Removes omitempty from a boolean field in restore strategy config. |
| api/v1alpha1/common.go | Removes omitempty from shared config boolean fields so false is serialized. |
| api/v1alpha1/apikey_types.go | Removes omitempty from an optional boolean pointer field. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
DavidLindbom
force-pushed
the
fix-boolean-omitempty
branch
from
b020443 to
d0f1782
Compare
Author
|
Restored |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #374
Motivation
When setting topicAutoCreationConfig.allow: false on a PulsarNamespace resource the operator updates the object with the field removed which causes our gitops tool to reapply the field. Over and over again.
Modifications
Removed
omitemptyfor all boolean fields.Verifying this change
This change added tests and can be verified as follows:
Documentation
no-need-docThe patch is not a functional change.